Skip to main content

FormInstance Properties

An object defining properties for the FormInstance class.

SecretKey​

Handles the encrypted secret key for the form, managing decryption and merging parameters if necessary.

Type: string

AgentMode​

Indicates if the form operates in agent mode, adjusting behavior and URL configurations for agent-based resources.

Type: bool

ProjectName​

The name of the project associated with this form instance.

Type: string

SecretObject​

Decrypts and returns the FormSecret object associated with the current SecretKey.

Type: FormSecret

FormName​

The name of the form associated with this instance.

Type: string

UserEvent​

Holds the user event information relevant to this form instance.

Type: UserEventInfo

Version​

Specifies the version of the form, with a default value of "latest".

Type: string

Parameters​

Contains a collection of parameters used within the form instance, initialized as an empty dictionary.

Type: Dictionary<string, object>

ClientForm​

Represents the client form data model linked to this form instance.

Type: ClientForm

DeploymentUrl​

Generates the deployment URL based on AgentMode, using a formatted string if agent mode is active, otherwise returning the standard deployment URL.

Type: string

Controls​

A collection of form controls associated with this form instance, excluding JSON serialization.

Type: Controls